Arroba Backend API (0.0.1)
Download OpenAPI specification:Download
| これがしたい | コマンド |
|---|---|
ログイン
このコマンドで取得したAccessTokenをAuthorizationsとして使用してください
|
|
| XXXX |
make xxxx-user1
|
| XXXX |
make xxxx-user2
|
| XXXX |
make xxxx-user3
|
ユーザ情報取得
SAMPLEです -
ユーザ情報取得
現時点でのユーザ情報を取得
Authorizations:
path Parameters
|
id
required
|
integer
<int64>
ユーザID |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{
-
"data":
{
-
"id":
2,
-
"type":
1,
-
"tel":
"08034772013",
-
"telMask":
"0803*******",
-
"mail":
"yns@tepo.co.jp",
-
"mailAuthenticatedAt":
"2023-04-21
17:00:10",
-
"token":
"6999724edfb1d2819783f16901bf74f493c8dedd93690a4c641c1674389bde5f"
}
}
ユーザ更新
SAMPLEです
ユーザ更新
ユーザ情報更新処理を行う。
Request Body schema: application/json
|
id
required
|
integer
<int64>
(userId)
ユーザID |
|
type
required
|
integer
<int64>
(userType)
[ 1 .. 2
]
Enum:
1
2
ユーザ種別
|
|
tel
required
|
string
(tel)
電話番号 |
|
mail
required
|
string or
null
(mail)
メールアドレス |
Responses
Request samples
- Payload
{
-
"id":
2,
-
"type":
1,
-
"tel":
"08034772013",
-
"mail":
"yns@tepo.co.jp"
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{
-
"data":
{
-
"id":
2,
-
"type":
1,
-
"tel":
"08034772013",
-
"telMask":
"0803*******",
-
"mail":
"yns@tepo.co.jp",
-
"mailAuthenticatedAt":
"2023-04-21
17:00:10",
-
"token":
"6999724edfb1d2819783f16901bf74f493c8dedd93690a4c641c1674389bde5f"
}
}
ユーザ検索
SAMPLEです -
ユーザ検索
指定したパラメーターでユーザ検索を行う
Authorizations:
query Parameters
| offset |
any
オフセット（サンプル） |
| limit |
any
ページリミット（サンプル） |
| userTel |
any
Example:
userTel=08034772013
電話番号（サンプル） |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{
-
"data":
[
-
{
-
"id":
2,
-
"type":
1,
-
"tel":
"08034772013",
-
"telMask":
"0803*******",
-
"mail":
"yns@tepo.co.jp",
-
"mailAuthenticatedAt":
"2023-04-21
17:00:10",
-
"token":
"6999724edfb1d2819783f16901bf74f493c8dedd93690a4c641c1674389bde5f"
}
]
}
ユーザ登録
SAMPLEです
ユーザ登録
ユーザ登録処理を行う。
利用シーン
- ユーザーの新規登録
- ゲストの臨時利用
Authorizations:
Request Body schema: application/json
|
id
required
|
integer
<int64>
(userId)
ユーザID |
|
type
required
|
integer
<int64>
(userType)
[ 1 .. 2
]
Enum:
1
2
ユーザ種別
|
|
tel
required
|
string
(tel)
電話番号 |
|
mail
required
|
string or
null
(mail)
メールアドレス |
Responses
Request samples
- Payload
{
-
"id":
2,
-
"type":
1,
-
"tel":
"08034772013",
-
"mail":
"yns@tepo.co.jp"
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{
-
"data":
{
-
"id":
2,
-
"type":
1,
-
"tel":
"08034772013",
-
"telMask":
"0803*******",
-
"mail":
"yns@tepo.co.jp",
-
"mailAuthenticatedAt":
"2023-04-21
17:00:10",
-
"token":
"6999724edfb1d2819783f16901bf74f493c8dedd93690a4c641c1674389bde5f"
}
}
取扱口座検索
取扱口座検索
指定したパラメーターで取扱口座検索を行う
Authorizations:
query Parameters
|
page
required
|
integer
<int64>
Example:
page=2
ページ番号 |
|
per_page
required
|
integer
<int64>
Example:
per_page=2
1ページあたり表示件数 |
| sort_target |
string
取扱口座検索ソート対象カラム
|
| sort_order |
string
Example:
sort_order=desc
ソート種別
|
| keyword |
string
取扱口座検索キーワード検索（下記に対して中間一致）
|
Responses
Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{
-
"data":
[
-
{
-
"id":
1,
-
"number":
1,
-
"account_name":
"三菱ＵＦＪ銀行 渋谷",
-
"bank_name":
"三菱ＵＦＪ銀行",
-
"branch_name":
"渋谷支店",
-
"deposit_withdrawal_category":
"入出金"
}
],
-
"links":
{
-
-
-
"prev":
null,
-
"next":
null
},
-
"meta":
{
-
"current_page":
1,
-
"from":
1,
-
"last_page":
34,
-
"links":
[
-
{
-
-
"label":
"«
Previous",
-
"active":
true
}
],
-
-
"per_page":
2,
-
"to":
10,
-
"total":
212
}
}
スタッフ検索
スタッフ検索
指定したパラメーターでスタッフ検索を行う
Authorizations:
query Parameters
|
page
required
|
integer
<int64>
Example:
page=2
ページ番号 |
|
per_page
required
|
integer
<int64>
Example:
per_page=2
1ページあたり表示件数 |
| sort_target |
any
Example:
sort_target=staffnumber
ソート対象カラム |
| sort_order |
string
Example:
sort_order=desc
ソート種別
|
| last_work_day_from |
any
Example:
last_work_day_from=2023-04-21
最終稼働日from |
| last_work_day_to |
any
Example:
last_work_day_to=2023-11-04
最終稼働日to |
| genders[] |
any
Example:
genders[]=male
性別
|
| branches[] |
any
Example:
branches[]=9mX6j6xffKhHdd389W1I
支店コード |
| keyword |
string
キーワード検索 |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{
-
"data":
[
-
{
-
"staff_id":
"XlHDCFCofwiQAglHm5bE",
-
"staff_number":
"999992",
-
"name":
"佐藤
元治",
-
"name_kana":
"サトウ
モトハル",
-
"branch_names":
[
-
"東京支店",
-
"船橋支店"
],
-
"gender":
"男性",
-
"dob":
"2023-01-04",
-
"age":
"27",
-
"last_working_day":
"2023-01-04"
}
],
-
"links":
{
-
-
-
"prev":
null,
-
"next":
null
},
-
"meta":
{
-
"current_page":
1,
-
"from":
1,
-
"last_page":
34,
-
"links":
[
-
{
-
-
"label":
"«
Previous",
-
"active":
true
}
],
-
-
"per_page":
2,
-
"to":
10,
-
"total":
212
}
}
標準報酬検索
標準報酬検索
標準報酬検索を行う
Authorizations:
query Parameters
|
page
required
|
integer
<int64>
Example:
page=2
ページ番号 |
|
per_page
required
|
integer
<int64>
Example:
per_page=2
1ページあたり表示件数 |
| sort_target[] |
Array of strings
Example:
sort_target[]=health_insurance_grade
ソート対象カラム
|
| sort_order[] |
Array of strings
Example:
sort_order[]=asc
ソート種別
|
Responses
Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{
-
"data":
[
-
{
-
"id":
1,
-
"health_insurance_grade":
1,
-
"pension_insurance_grade":
1,
-
"standard_reward_monthly_amount":
68000,
-
"standard_reward_monthly_amount_or_more":
63000,
-
"standard_reward_monthly_amount_less_than":
73000
}
],
-
"links":
{
-
-
-
"prev":
null,
-
"next":
null
},
-
"meta":
{
-
"current_page":
1,
-
"from":
1,
-
"last_page":
34,
-
"links":
[
-
{
-
-
"label":
"«
Previous",
-
"active":
true
}
],
-
-
"per_page":
2,
-
"to":
10,
-
"total":
212
}
}
部門検索
部門検索
指定したパラメーターで部門検索を行う
Authorizations:
query Parameters
|
page
required
|
integer
<int64>
Example:
page=2
ページ番号 |
|
per_page
required
|
integer
<int64>
Example:
per_page=2
1ページあたり表示件数 |
| sort_target |
string
Example:
sort_target=department_no
ソート対象カラム 指定可能な項目は以下の項目
※ |
| sort_order |
string
Example:
sort_order=desc
ソート種別
|
| keyword |
string
キーワード検索 |
| deleted |
string
削除可否
|
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{
-
"data":
[
-
{
-
"id":
1,
-
"department_no":
1,
-
"department_abbreviation":
"池袋支店",
-
"department_name":
"(閉鎖)千葉支店",
-
"parent_department_name":
"都道圏第二エリア",
-
"department_order":
999
}
],
-
"links":
{
-
-
-
"prev":
null,
-
"next":
null
},
-
"meta":
{
-
"current_page":
1,
-
"from":
1,
-
"last_page":
34,
-
"links":
[
-
{
-
-
"label":
"«
Previous",
-
"active":
true
}
],
-
-
"per_page":
2,
-
"to":
10,
-
"total":
212
}
}
担当者検索
担当者検索
指定したパラメーターで担当者検索を行う
Authorizations:
query Parameters
|
page
required
|
integer
<int64>
Example:
page=2
ページ番号 |
|
per_page
required
|
integer
<int64>
Example:
per_page=2
1ページあたり表示件数 |
| sort_target |
string
Example:
sort_target=department_no
ソート対象カラム 指定可能な項目は以下の項目
※ |
| sort_order |
string
Example:
sort_order=desc
ソート種別
|
| keyword |
string
キーワード検索 |
| department_id |
integer
Example:
department_id=1
部門ID |
|
search_category
required
|
integer
Example:
search_category=1
対象
※ |
| deleted |
string
削除可否
|
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{
-
"data":
[
-
{
-
"id":
1,
-
"staff_number":
"999992",
-
"name":
"馬場忠弘",
-
"name_kana":
"バンバタダヒロ",
-
"branch_name":
"渋谷支店"
}
],
-
"links":
{
-
-
-
"prev":
null,
-
"next":
null
},
-
"meta":
{
-
"current_page":
1,
-
"from":
1,
-
"last_page":
34,
-
"links":
[
-
{
-
-
"label":
"«
Previous",
-
"active":
true
}
],
-
-
"per_page":
2,
-
"to":
10,
-
"total":
212
}
}
得意先区分
指定した得意先区分に対する
id・nameを全件取得
Authorizations:
query Parameters
|
customer_classification
required
|
string
Example:
customer_classification=12
得意先区分 指定可能な項目は以下の項目
|
|
type_master_category
required
|
integer
[ 0
.. 12 ]
Example:
type_master_category=1
インポート時はclassificationに対応した値 |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{
-
"data":
[
-
{
-
"id":
1,
-
"type_number":
1,
-
"name":
"名前・名称"
}
]
}
給料台帳（印刷）検索
給料台帳(印刷)検索
指定したパラメーターで給料台帳(印刷)検索を行う
Authorizations:
query Parameters
|
page
required
|
integer
<int64>
Example:
page=2
ページ番号 |
|
per_page
required
|
integer
<int64>
Example:
per_page=2
1ページあたり表示件数 |
| sort_target[] |
Array of strings
Example:
sort_target[]=staff_number
ソート対象カラム
|
| sort_order[] |
Array of strings
Example:
sort_order[]=asc
ソート種別
|
|
salary_payment_date_from
required
|
any
Example:
salary_payment_date_from=2023-04-21
給料支給日from |
|
salary_payment_date_to
required
|
any
Example:
salary_payment_date_to=2023-11-04
給料支給日to |
| staff_number_from |
any
Example:
staff_number_from=000001
スタッフNO from |
| staff_number_to |
any
Example:
staff_number_to=000002
スタッフNO to |
| payroll_group |
any
Example:
payroll_group=1
給与締グループ |
| payment_method |
any
Example:
payment_method=0
給与支給方法 |
| tax_classification |
any
Example:
tax_classification=1
課税区分 |
| fs_department_id |
any
Example:
fs_department_id=1
所属部門id |
| handling_account_no |
any
Example:
handling_account_no=0001
取扱口座NO |
Responses
Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{
-
"data":
[
-
{
-
"id":
1,
-
"staff_number":
"999992",
-
"staff_name":
"名前",
-
"department_name":
"(閉鎖)千葉支店"
}
],
-
"links":
{
-
-
-
"prev":
null,
-
"next":
null
},
-
"meta":
{
-
"current_page":
1,
-
"from":
1,
-
"last_page":
34,
-
"links":
[
-
{
-
-
"label":
"«
Previous",
-
"active":
true
}
],
-
-
"per_page":
2,
-
"to":
10,
-
"total":
212
}
}